Skip to content

Update package docs to new Roxygen approach#39

Open
hdbeukel wants to merge 6 commits intodevelopfrom
release/3.2.3
Open

Update package docs to new Roxygen approach#39
hdbeukel wants to merge 6 commits intodevelopfrom
release/3.2.3

Conversation

@hdbeukel
Copy link
Copy Markdown
Member

I got this email from CRAN:


Dear maintainer,

You have file 'corehunter/man/corehunter.Rd' with \docType{package},
likely intended as a package overview help file, but without the
appropriate PKGNAME-package \alias as per "Documenting packages" in
R-exts.

This seems to be the consequence of the breaking change

  Using @docType package no longer automatically adds a -package alias.
  Instead document _PACKAGE to get all the defaults for package
  documentation.

in roxygen2 7.0.0 (2019-11-12) having gone unnoticed, see
<https://github.com/r-lib/roxygen2/issues/1491>.

As explained in the issue, to get the desired PKGNAME-package \alias
back, you should either change to the new approach and document the new
special sentinel

  "_PACKAGE"

or manually add

  @aliases corehunter-package

if remaining with the old approach.

Please fix in your master sources as appropriate, and submit a fixed
version of your package within the next few months.

Best,
-k

Package documentation has been updated accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants